1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use crate::sketchbook::ids::{DynPropertyId, StatPropertyId};
use crate::sketchbook::properties::PropertyManager;
use crate::sketchbook::Manager;

/// Methods for safely generating new valid (unique) instances of identifiers for
/// the current `PropertyManager`.
impl PropertyManager {
    /// Generate valid `DynPropertyId` that's currently not used by any dynamic property in this
    /// `PropertyManager`.
    ///
    /// First, the given `ideal_id` or its transformation by replacing invalid characters are tried.
    /// If they are both invalid (non-unique), a numerical identifier is added at the end.
    /// By specifying `start_index`, the index search starts directly at that number (e.g., when
    /// ideal ID is "prop" and start index is 3, search for ID starts with "prop_3", "prop_4", ...)
    ///
    /// **Warning:** Do not use this to pre-generate more than one id at a time, as the process
    /// is deterministic and might generate the same IDs. Always generate an Id, add that property,
    /// and then repeat for other properties.
    pub fn generate_dyn_property_id(
        &self,
        ideal_id: &str,
        start_index: Option<usize>,
    ) -> DynPropertyId {
        self.generate_id(
            ideal_id,
            &(Self::is_valid_dyn_property_id),
            self.num_dyn_properties(),
            start_index,
        )
    }

    /// Generate valid `StatPropertyId` that's currently not used by any static property in this
    /// `PropertyManager`.
    ///
    /// First, the given `ideal_id` or its transformation by replacing invalid characters are tried.
    /// If they are both invalid (non-unique), a numerical identifier is added at the end.
    /// By specifying `start_index`, the index search starts directly at that number (e.g., when
    /// ideal ID is "prop" and start index is 3, search for ID starts with "prop_3", "prop_4", ...)
    ///
    /// **Warning:** Do not use this to pre-generate more than one id at a time, as the process
    /// is deterministic and might generate the same IDs. Always generate an Id, add that property,
    /// and then repeat for other properties.
    pub fn generate_stat_property_id(
        &self,
        ideal_id: &str,
        start_index: Option<usize>,
    ) -> StatPropertyId {
        self.generate_id(
            ideal_id,
            &(Self::is_valid_stat_property_id),
            self.num_stat_properties(),
            start_index,
        )
    }
}